Detach Subscriber Offer

This API is used to detach a Regular or Pool Plan from a subscriber. The deletion is soft, but once executed, it cannot be recovered.

If required, Attach Subscriber Offer should be used.

HTTP URL
DELETE	//api/v2/subscriber/{type}/{value}/offer/{id}

NOTE: All {type} and {value} pairs, define the search criteria. Valid {type} ENUMs are: ‘imsi’, ‘iccid’, ‘msisdn’, ‘imei’.

Eligibility

The Requester is eligible to detach a plan from sub-customers’ subscribers.

The Requester is eligible to detach a Buy Plan from own subscribers only if the Parent account sets the allowOfferDelegation parameter to True for the Requester’s account.

API Request

Request Structure

Parameter	Type	M/O/CM	Description
myOffer	Boolean	O	Determines whether to: Detach one of my Customer plans (Sell Plan offers) from my sub accounts’ subscribers OR Detach one of the Parent’s Buy Plans from my accounts’ subscribers. [myOffer] True = Request to detach a Parent plan (Buy Plan offer) from my own subscribers. This self-service functionality is allowed only when the sub-customer was defined by my Parent as authorized for delegation of Parent Plans [myOffer] False = Request to detach one of my Customer plans (Sell Plan offers) to my sub accounts subscribers (Normal operation) Default (if not provided) = False

Parameter

Type

M/O/CM

Description

myOffer

Boolean

Determines whether to:

Detach one of my Customer plans (Sell Plan offers) from my sub accounts’ subscribers

Detach one of the Parent’s Buy Plans from my accounts’ subscribers.

[myOffer] True = Request to detach a Parent plan (Buy Plan offer) from my own subscribers. This self-service functionality is allowed only when the sub-customer was defined by my Parent as authorized for delegation of Parent Plans

[myOffer] False = Request to detach one of my Customer plans (Sell Plan offers) to my sub accounts subscribers (Normal operation)

Default (if not provided) = False

API Response

Response Structure

Parameter	Type	M/O/CM	Description
errorCode	String	O	Failure code.
errorMessage	String	O	Failure message.
content	Object	O	Array of main response body object displayed when an API call was successful. For a failure, it will be empty.
pageable	Object	O	Paging information object displayed when an API call was successful. For a failure, it will be empty.

Content data objects

Element	Type	M/O/CM	Description
requestId	UUID	M	Request instance ID. To be used by external systems to query the call (operation) status: In progress Successful Failed.

Element

Type

M/O/CM

Description

requestId

UUID

Request instance ID.

To be used by external systems to query the call (operation) status:

In progress

Successful

Failed.

Pageable data objects

Element	Type	M/O/CM	Description
page	Numeric	M	Page number
size	Numeric	M	Page size. Number of requested elements per page
totalPages	Numeric	M	Total amount of available pages per requested page size
totalElements	Numeric	M	Total amount of retrieved elements

Error Codes

In addition to the general success and failure codes, the following error codes are possible.

Code	Message
GLOBAL_1001	Service unavailable. Please try again
SUBSCRIBER_1002	Subscriber does not exist
SUBSCRIBER_1011	Failed to detach offer\s
SUBSCRIBER_1028	You are not allowed to detach parent customer plans to your own SIM cards
SUBSCRIBER_1033	Ambiguous call. You have multiple offers. Please specify the offer ID to top-up

Examples

Request Body

Copy

{
   "myOffer": false
}

Response Body: Success ACK

Copy

{
  "errorCode": "",
  "errorMessage": "",
  "content": [
    {
      "requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370"
    }
  ],
  "pageable": {
    "page": 0,
    "size": 10,
    "totalPages": 1,
    "totalElements": 1
  }
}

Response Body: Failure NAK

Copy

{
  "errorCode": "SUBSCRIBER_1011",
  "errorMessage": "Failed to detach offer\s",
  "content": "",
  "pageable": ""
}